/*
 * Copyright 2023 devaper
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.github.devaper.pigeon.response

import io.github.devaper.pigeon.support.*
import java.util.concurrent.*

/**
 * 异步响应结果
 */
interface Deferred<T> {

    /**
     * 等待并获取异步的响应结果
     *
     * @return 响应结果
     */
    fun get(): T

    /**
     * 等待并获取异步的响应结果
     *
     * @param timeout 超时时间
     * @param unit 时间单位
     * @return 响应结果
     */
    fun getWithTimeout(timeout: Long, unit: TimeUnit): T

    companion object {
        @JvmStatic
        fun <T> of(data: T): Deferred<T> {
            return ImmediateDeferred(data)
        }
    }

}